home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / util / wb / pubit_101.lha / pubit101 / PubIt-Manual < prev    next >
Text File  |  1994-09-27  |  16KB  |  282 lines
  1.  
  2.             PubIt V1.01 - The Public Public-Screen-Creator
  3.            Copyright © 1994 by Christoph (Confusio) Rickers
  4.  
  5.  
  6.                       D o c u m e n t a t i o n
  7.                       =========================
  8.  
  9.  
  10.   DISCLAIMER:   PubIt is NOT Public Domain, but it may be copied and
  11.                 included in public libraries, as long as the following
  12.                 rules are obeyed:
  13.  
  14.                 1)  The program is only spread in form of the original
  15.                     lha-archive.
  16.                 2)  No modifications are made to the program, the docs,
  17.                     or anything else in the distribution *).
  18.                 3)  You don't ask any money for PubIt.
  19.  
  20.                 The author cannot be made responsible for any faults, errors
  21.                 and such caused by the use of this program, you use this 
  22.                 AS IS (means ON YOUR OWN RISK).
  23.  
  24.                 Note that this program has not been tested over a longer period,
  25.                 but it should work (I've discovered no more bugs!)
  26.  
  27.                 *)  I've decided to release the source code to the public,
  28.                     too. For the rules on using and/or modifying the source,
  29.                     read the PROGRAMMERS part below.
  30.  
  31.   PROGRAM:      PubIt is a small tool to open a highly configurable public 
  32.                 screen and run an application on it. Its differs from other
  33.                 pubscreen tools in the following aspects:
  34.  
  35.                 1)  You can specify the public screen in almost any kind
  36.                     (screen mode, -size, colors, dripens, title, pubname ...)
  37.                 2)  You can specify an application via tooltypes, which
  38.                     is started after the screen is opened.
  39.                     Some additional tooltypes enable you to use PubIt in a
  40.                     transparent way: If you once defined the screen outfit
  41.                     and the application, you just click on the PubIt Icon,
  42.                     and your application is run on the desired screen. After
  43.                     you quit the application, PubIt may quit immediately (if
  44.                     you want this!),
  45.  
  46.   REQUIREMENTS: PubIt needs Kickstart Version 38+ (3.0+) and Nico François Reqtools
  47.                 library for the requesters to run. If you want to use
  48.                 it with Kick 2.0, 2.1 you'll have to recompile it and rewrite
  49.                 the dripen-part (I won't do this, sorry!).
  50.  
  51.   PROGRAMMERS:  The source code is included in the distribution for those of
  52.                 you who find s.th. to improve. The modified source and executable
  53.                 are NOT TO BE DISTRIBUTED --> You may of course use the modified
  54.                 version yourself. If you like to get your version of PubIt
  55.                 distributed, please send me a version of the modified source and
  56.                 add a note to the history file. I would like you to mark the
  57.                 modified sections in the source with a note, that YOU (name) have
  58.                 done it. I will then distribute your version as the new one, to
  59.                 make it available to the public. This is the ONLY ALLOWED WAY to
  60.                 DISTRIBUTE any version of PubIt or similar programs which use
  61.                 parts of the PubIt source.
  62.  
  63.   DOC:          PubIt supports a lot of tooltypes to specify the screen outfit,
  64.                 like color-palette, dripens (these are the pens, you can adjust
  65.                 with the color-preferences in `multi-color-mode`). Further more
  66.                 you can define an application wich is started after the screen
  67.                 is opened.
  68.  
  69.                 Note  that the preferences are saved in the icon's tooltypes, but
  70.                       the palette is saved in a separate file. If you want
  71.                       different screens for different programs, you'll have to
  72.                       make copies of PubIt (and icon).
  73.  
  74.                 To configure the screenmode, the color palette, font and the
  75.                 application data, you can simply start PubIt (dubble click on the
  76.                 workbench). PubIt will then open a PAL Highres screen with it's 
  77.                 menu on it.
  78.  
  79.                 Screenmode...       Opens a screenmode requester. You can
  80.                                     specify the screenmode, size and depth of
  81.                                     the mode to be used. PubIt will immediately
  82.                                     adjust itself to the selected mode.
  83.                 Color-Palette...    Opens a palette requester. You can adjust
  84.                                     the color palette to the desired colors.
  85.                                     Note: If no application is defined, PubIt
  86.                                           will ask you, if you'll like to
  87.                                           save the palette as the default one.
  88.                                           Otherwise the palette is saved in the
  89.                                           drawer of the defined application, as
  90.                                           <application.pal>
  91.                 Define DriPens...   Opens a requester which enables you to
  92.                                     modify the dripens.
  93.  
  94.                                     The Pens-Gadget shows the actual dripen:
  95.                                     The dripens are:
  96.                                     DETAIL:        Detail-Pen (default: grey)
  97.                                     BLOCK:         Block-Pen  (default: black)
  98.                                     TEXT:          Text-Pen   (default: black)
  99.                                     SHINE:         Shine-Pen  
  100.                                                    ... is used for the light
  101.                                                    edges of windows, gadgets,
  102.                                                    icons, etc.
  103.                                                    (default:  white)
  104.                                     SHADOW:        Shadow-Pen 
  105.                                                    ... is used for the dark
  106.                                                    edges of windows, gadgets,
  107.                                                    icons, etc.
  108.                                                    (default:  black)
  109.                                     FILL:          Fill-Pen   
  110.                                                    ... is used for the border of
  111.                                                    active windows.
  112.                                                    (default:  blue)
  113.                                     FILLTEXT:      Filltext-Pen
  114.                                                    ... is used for the title text
  115.                                                    of active windows.
  116.                                                    (default:  black)
  117.                                     BACKGROUND:    Background-Pen
  118.                                                    ... seems to be the background
  119.                                                    color, eh?
  120.                                                    (default:  grey)
  121.                                     HIGHLIGHTEXT:  Highlight-text-Pen
  122.                                                    ... is used for imporatant 
  123.                                                    text.
  124.                                                    (default:  white)
  125.                                     BARDETAIL:     Bardetail-Pen
  126.                                                    ... is used for the text in the
  127.                                                    screens title bar.
  128.                                                    (default:  black)
  129.                                     BARBLOCK:      Barblock-Pen
  130.                                                    ... is used for the color of
  131.                                                    the bar itself.
  132.                                                    (default:  white)
  133.                                     BARTRIM:       Bartrim-Pen
  134.                                                    ... is used for the line below
  135.                                                    the title bar
  136.                                                    (default:  black)
  137.  
  138.                                     To modify the color of a dripen, select the
  139.                                     pen (using the Pens-Gadget) and then select
  140.                                     the color. The actual color is displayed in
  141.                                     the rectangular field, right of the Color
  142.                                     Gadget.
  143.  
  144.                                     Note  the new DriPens become active, after the
  145.                                           screen is once closed and reopened.
  146.  
  147.                 Font...             Opens a font requester. You can specify the
  148.                                     font and it's size for the screen to open.
  149.  
  150.                                     Note: the new font becomes active, after the
  151.                                           screen is once closed and reopened.
  152.  
  153.                 Set Application...  Opens a requester for the application data.
  154.                                     Path/File: is a valid path and filename of
  155.                                                your application to start,
  156.                                     Priority:  gives the task-priority, your
  157.                                                application will be run with.
  158.                                     Stack:     is the stack for the appli.
  159.  
  160.                 You can also specify these (and more, but color palette) parameters
  161.                 by setting the Tooltypes of the icon directly. You can do this by
  162.                 selecting the PubIt Icon, and then select `Icon/Info...` from the
  163.                 workbench menus. For more details, see workbench documentation.
  164.  
  165.                 PubIt `knows` the following tooltypes:
  166.  
  167.                 Tooltypes for the application...
  168.  
  169.                   APPNAME             the name of the application to start (s.a.)
  170.                   APPPRI              the taskpriority of the application to start
  171.                   APPSTACK            the stacksize of the application
  172.                   APPARGS             shell arguments for the application.
  173.  
  174.                 Tooltypes for the public screen...
  175.  
  176.                   PUBNAME             Name of the public screen (this is not the
  177.                                       screen's title!)
  178.                   PUBTITLE            titlebar text of public screen.
  179.                   SHOWNAME            <YES/NO> display pubscreen's (PUBNAME) name
  180.                                       in the title bar.
  181.                   DEPTH               Number of bitplanes for the screen, valid
  182.                                       numbers are: 1..8 (2..256 colors)
  183.                   WIDTH               the screen width in pixels.
  184.                                       this may be more than visible -> PubIt opens
  185.                                       any screen in Autoscroll Mode.
  186.                   HEIGHT              the screen height in pixels.
  187.                                       this may be more than visible -> PubIt opens
  188.                                       any screen in Autoscroll Mode.
  189.                   DISPLAYID           displayid of screenmode.
  190.               
  191.                   FONTNAME            name of screen font.
  192.                   FONTSIZE            size of the font.
  193.  
  194.                   POPSTART            <YES/NO> prompt a screenmode requester on
  195.                                       every start.
  196.                   INTERLEAVED         <YES/NO> use interleaved bitmaps on screen.
  197.                   SHANGHAI            <YES/NO> use public screen in shanghai
  198.                                       mode: This means the public screen will be
  199.                                       the default public screen (normally this is
  200.                                       workbench) and any window which is normally
  201.                                       opened on the workbench will be opened on
  202.                                       the PubIt-screen.
  203.                   FQUIT               <YES/NO> quit immediately after application
  204.                                       has returned. Note: Some applications detach
  205.                                       themselves from the shell/cli, use FWQUIT
  206.                                       for these applications.
  207.                   FWQUIT              <YES/NO> quit immediately, after all windows 
  208.                                       are closed on public screen.
  209.  
  210.   THANKS:         I'd like to thank the following people:
  211.  
  212.                   - my girlfriend for accepting what I'm doing,
  213.                   - Bastian Kinne for the idea, testing and for the great icons.
  214.                   - Dietmar Eilert for his phantastic GoldEd 
  215.                     (please improve the block handling!)
  216.                   - Stefan Stunz for MUI,
  217.                   - Martin Huttenloher for his great MagicWB (2.0),
  218.                   - Dirk Federlein for DFA
  219.                   - The men behind SASG for their work,
  220.                   - Yes, Tori Amos, Jethro Tull, Rebecca Pidgeon and others
  221.                     for inspiring / supporting me with good music and T+A for
  222.                     the high quality of their criterion-speaker-systems...
  223.                   - Commodore for the Amiga.
  224.                   - anyone who wrote me a card...
  225.  
  226.   SYSTEM:         This program was developed and tested on the following system
  227.                   configuration:
  228.  
  229.                     A4000 EC68030 MC68882, 25MHz
  230.                     Kickstart version 39.106, Workbench version 40.35
  231.                     2Mb Chip Memory, 8Mb Fast Memory,
  232.                     2 Seagate HDs (84Mb, 124Mb)
  233.                     Piccolo Gfx Board,
  234.  
  235.                   Tested also on
  236.  
  237.                     A4000 MC68040 MC68882, 25MHz
  238.                     Kickstart version 39.106, Workbench version 40.35
  239.                     2Mb Chip Memory, 4Mb Fast Memory,
  240.                     450Mb Connor HD.
  241.  
  242.   AUTHOR:         If you have any bug reports, you want to write me a card,
  243.                   or anything else, you can reach me at:
  244.  
  245.                     Christoph Rickers
  246.                     Bismarckstraße 71
  247.                     28203 Bremen
  248.                     - Germany -
  249.  
  250.                     Phone: (+49) 0421 - 75107     (18:00 - 20:00 weekdays)
  251.  
  252.                   EMail will change in the near future and is therefor not
  253.                   included.
  254.  
  255.                   Please do not expect me to answer. If you have questions,
  256.                   please phone me or include a return enveloppe and stamp,
  257.                   thanx.
  258.  
  259.   Current Project:      MUI-Statistics Program
  260.                         for the work and graphical display of measured data.
  261.                         This is useful for students of science...
  262.                         (No name, yet).
  263.  
  264.   Future Project:       MUI-Calculation Program
  265.                         like Microsoft's Exel. Any suggestions are welcome,
  266.                         (this may take a while. No name, yet!)
  267.  
  268.                   both programs will cost below DM 50,- and will be shareware
  269.                   under the rules of SASG (perhaps exept for the price!)
  270.  
  271.   Thanks for using PubIt,
  272.  
  273.     Chris
  274.  
  275.                                                     +-------------------------------+
  276.                                                     | ... God is real,              |
  277.                                                     |     unless declared integer.  |
  278.                                                     +-------------------------------+
  279.  
  280.  
  281.   Amiga lives...
  282.